home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / AIncludes / SystemLogging.a < prev    next >
Text File  |  1996-05-01  |  6KB  |  239 lines
  1. ;
  2. ;    File:        SystemLogging.a
  3. ;
  4. ;    Contains:    System Logging Service
  5. ;
  6. ;    Version:    Technology:    1.0
  7. ;                Release:    Universal Interfaces 3.0d3 on Copland DR1
  8. ;
  9. ;    Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10. ;
  11. ;    Bugs?:        If you find a problem with this file, send the file and version
  12. ;                information (from above) and the problem description to:
  13. ;
  14. ;                    Internet:    apple.bugs@applelink.apple.com
  15. ;                    AppleLink:    APPLE.BUGS
  16. ;
  17. ;
  18.     IF &TYPE('__SYSTEMLOGGING__') = 'UNDEFINED' THEN
  19. __SYSTEMLOGGING__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.     IF &TYPE('__TEXTOBJECTS__') = 'UNDEFINED' THEN
  25.     include 'TextObjects.a'
  26.     ENDIF
  27.     IF &TYPE('__TIMEOBJECTS__') = 'UNDEFINED' THEN
  28.     include 'TimeObjects.a'
  29.     ENDIF
  30.     IF &TYPE('__AEDATAMODEL__') = 'UNDEFINED' THEN
  31.     include 'AEDataModel.a'
  32.     ENDIF
  33.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  34.     IF FOR_PTR_BASED_AE THEN
  35. ;  Service types 
  36. ; typedef UInt32                         LogID
  37.  
  38. ; typedef UInt32                         LogIterator
  39.  
  40. ;  Situation Types 
  41. ; typedef UInt32                         LogSituationType
  42.  
  43.  
  44. kLogTypeInformation                EQU        'info'
  45. kLogTypeWarning                    EQU        'warn'
  46. kLogTypeFatal                    EQU        'fatl'
  47. kLogTypeSystemFatal                EQU        'sysf'
  48. kLogTypeAll                        EQU        '****'
  49. ;  System Logging Areas 
  50. ; typedef UInt32                         LogArea
  51.  
  52.  
  53. kLogAreaIO                        EQU        'io  '
  54. kLogAreaNetworking                EQU        'netw'
  55. kLogAreaKernel                    EQU        'kern'
  56. kLogAreaApplication                EQU        'appl'
  57. kLogAreaBoot                    EQU        'boot'
  58. kLogAreaPrinting                EQU        'prnt'
  59. kLogAreaCommunication            EQU        'comm'
  60. kLogAreaServer                    EQU        'serv'
  61. kLogAreaAll                        EQU        '****'
  62. ;  Service Version 
  63. ; typedef UInt32                         LogVersion
  64.  
  65.  
  66. kLogVersion1                    EQU        1
  67. kLogCurrentVersion                EQU        1
  68. ;  Log Message Versions 
  69. ; typedef UInt32                         LogMsgVersion
  70.  
  71.  
  72. kLogMsgVersion1                    EQU        1
  73. kLogCurrentMsgVersion            EQU        1
  74. ;  Message Flags 
  75. ; typedef UInt32                         LogMsgFlags
  76.  
  77.  
  78. kLogMsgFlagsDataTruncated        EQU        $00000001
  79. kLogMsgFlagsReceivedCorrupted    EQU        $00000002
  80. kLogMsgFlagsTimeInUptime        EQU        $00000004
  81. kLogMsgFlagsNotified            EQU        $00000008
  82. LogMessage                RECORD 0
  83. msgSize                     ds.l    1                ; offset: $0 (0)
  84. msgVersion                 ds.l    1                ; offset: $4 (4)
  85. msgFlags                 ds.l    1                ; offset: $8 (8)
  86. msgSituationType         ds.l    1                ; offset: $C (12)
  87. msgRepeatedCount         ds.l    1                ; offset: $10 (16)
  88. msgArea                     ds.l    1                ; offset: $14 (20)
  89. msgClient                 ds.l    1                ; offset: $18 (24)
  90. msgTimestamp             ds        TimeObject        ; offset: $1C (28)
  91. msgDataCount             ds.l    1                ; offset: $2C (44)
  92. msgStatus                 ds.l    1                ; offset: $30 (48)
  93. msgTextSize                 ds.l    1                ; offset: $34 (52)
  94. sizeof                     EQU *                    ; size:   $38 (56)
  95.                         ENDR
  96. ; typedef struct LogMessage *            LogMessagePtr
  97.  
  98.  
  99. kLogMaxMessageSize                EQU        1024
  100. ; typedef UInt32                         LogStatisticsVersion
  101.  
  102.  
  103. kLogStatisticsVersion1            EQU        1
  104. kLogStatisticsCurrentVersion    EQU        1
  105. ;  System Logging Statistics 
  106. LogStatistics            RECORD 0
  107. statsVersion             ds.l    1                ; offset: $0 (0)
  108. situationMsgsDropped     ds.l    1                ; offset: $4 (4)
  109. situationMsgsTruncated     ds.l    1                ; offset: $8 (8)
  110. situationMsgsLoggedThisSession  ds.l 1            ; offset: $C (12)
  111. situationMsgsCurrentlyInTheLog  ds.l 1            ; offset: $10 (16)
  112. situationMsgsNotified     ds.l    1                ; offset: $14 (20)
  113. pluginsInstalled         ds.l    1                ; offset: $18 (24)
  114. sizeof                     EQU *                    ; size:   $1C (28)
  115.                         ENDR
  116. ;  Variables and constants for use in the System Notication Service 
  117.  
  118. kSystemLoggingService            EQU        'slss'
  119. kLogSNSMsgKind                    EQU        'slsm'
  120. kLogSNSMsgSubjectSize            EQU        12
  121. ;  Basic Logging routine 
  122. ;
  123. ; extern OSStatus LogSituation(LogSituationType situationType, LogArea situationArea, OSType situationClient, TextObject situationText, OSStatus situationStatus, AEStream situationData)
  124. ;
  125.     IF GENERATINGCFM THEN
  126.         IMPORT_CFM_FUNCTION LogSituation
  127.     ENDIF
  128.  
  129. ;  System Logging Service Administration APIs 
  130. ;
  131. ; extern OSStatus LogOpen(LogID *theService, TextObject clientName)
  132. ;
  133.     IF GENERATINGCFM THEN
  134.         IMPORT_CFM_FUNCTION LogOpen
  135.     ENDIF
  136.  
  137. ;
  138. ; extern OSStatus LogClose(LogID theService)
  139. ;
  140.     IF GENERATINGCFM THEN
  141.         IMPORT_CFM_FUNCTION LogClose
  142.     ENDIF
  143.  
  144. ;
  145. ; extern OSStatus LogGetClientName(TextObject clientName)
  146. ;
  147.     IF GENERATINGCFM THEN
  148.         IMPORT_CFM_FUNCTION LogGetClientName
  149.     ENDIF
  150.  
  151. ;
  152. ; extern OSStatus LogClear(LogID theService)
  153. ;
  154.     IF GENERATINGCFM THEN
  155.         IMPORT_CFM_FUNCTION LogClear
  156.     ENDIF
  157.  
  158. ;
  159. ; extern OSStatus LogFlush(LogID theService)
  160. ;
  161.     IF GENERATINGCFM THEN
  162.         IMPORT_CFM_FUNCTION LogFlush
  163.     ENDIF
  164.  
  165. ;
  166. ; extern OSStatus LogGetCommAreaSize(LogID theService, ByteCount *size)
  167. ;
  168.     IF GENERATINGCFM THEN
  169.         IMPORT_CFM_FUNCTION LogGetCommAreaSize
  170.     ENDIF
  171.  
  172. ;
  173. ; extern OSStatus LogSetCommAreaSize(LogID theService, ByteCount size)
  174. ;
  175.     IF GENERATINGCFM THEN
  176.         IMPORT_CFM_FUNCTION LogSetCommAreaSize
  177.     ENDIF
  178.  
  179. ;
  180. ; extern OSStatus LogCreateIterator(LogID theService, LogIterator *iterator)
  181. ;
  182.     IF GENERATINGCFM THEN
  183.         IMPORT_CFM_FUNCTION LogCreateIterator
  184.     ENDIF
  185.  
  186. ;
  187. ; extern OSStatus LogGetEntry(LogIterator iterator, LogMsgVersion version, LogMessage *msg)
  188. ;
  189.     IF GENERATINGCFM THEN
  190.         IMPORT_CFM_FUNCTION LogGetEntry
  191.     ENDIF
  192.  
  193. ;
  194. ; extern OSStatus LogDisposeIterator(LogIterator iterator)
  195. ;
  196.     IF GENERATINGCFM THEN
  197.         IMPORT_CFM_FUNCTION LogDisposeIterator
  198.     ENDIF
  199.  
  200. ;
  201. ; extern OSStatus LogExtractText(LogMessage *entry, TextObject text)
  202. ;
  203.     IF GENERATINGCFM THEN
  204.         IMPORT_CFM_FUNCTION LogExtractText
  205.     ENDIF
  206.  
  207. ;
  208. ; extern OSStatus LogExtractAEDesc(LogMessage *entry, AEDesc *desc)
  209. ;
  210.     IF GENERATINGCFM THEN
  211.         IMPORT_CFM_FUNCTION LogExtractAEDesc
  212.     ENDIF
  213.  
  214. ;
  215. ; extern OSStatus LogGetStatistics(LogID theService, LogStatisticsVersion version, LogStatistics *statistics)
  216. ;
  217.     IF GENERATINGCFM THEN
  218.         IMPORT_CFM_FUNCTION LogGetStatistics
  219.     ENDIF
  220.  
  221. ;
  222. ; extern OSStatus LogGetLogSize(LogID theService, ByteCount *maxSize)
  223. ;
  224.     IF GENERATINGCFM THEN
  225.         IMPORT_CFM_FUNCTION LogGetLogSize
  226.     ENDIF
  227.  
  228. ;
  229. ; extern OSStatus LogSetLogSize(LogID theService, ByteCount maxSize)
  230. ;
  231.     IF GENERATINGCFM THEN
  232.         IMPORT_CFM_FUNCTION LogSetLogSize
  233.     ENDIF
  234.  
  235.     ENDIF
  236.     ENDIF
  237.     ENDIF ; __SYSTEMLOGGING__ 
  238.  
  239.